版本

# 权限管理接口


# 接口列表:


# 认证

# 方法

Response auth(String username,
              String password)

# 参数

参数列表 类型 描述 是否可空 默认值 示例 备注
username String 用户名 * "graph_owner" 符合正则表达式规则 [_A-Za-z0-9]{1,32}
password String 密码 * "12345678" 符合正则表达式规则 [_A-Za-z0-9]{8,32}

# 返回值

参数列表 类型 描述 是否可空 默认值 示例 备注
_return Response 认证响应结果 * *

# 创建用户

# 方法

Response create_user(String username,
               String password,
               String graph,
               List<String> roles)

# 参数

参数列表 类型 描述 是否可空 默认值 示例 备注
username String 用户名 * "graph_owner" 符合正则表达式规则 [_A-Za-z0-9]{1,32}
password String 密码 * "12345678" 符合正则表达式规则 [_A-Za-z0-9]{8,32}
graph String 数据库名称 * "ezoo" 不超过32个字符
roles List 角色列表 * ["graphowner"]

# 返回值

参数列表 类型 描述 是否可空 默认值 示例 备注
_return Response 创建用户响应结果 * *

# 删除用户

# 方法

Response drop_user(String username);

# 参数

参数列表 类型 描述 是否可空 默认值 示例 备注
username String 用户名 * "graph_owner" 符合正则表达式规则 [_A-Za-z0-9]{1,32}

# 返回值

参数列表 类型 描述 是否可空 默认值 示例 备注
_return Response 删除用户响应结果 * *

# 修改密码

# 方法

Response change_password(String old_password,
               String password);

# 参数

参数列表 类型 描述 是否可空 默认值 示例 备注
old_password String 需要修改的密码 * "12345678" [_A-Za-z0-9]{1,32}
password String 密码 * "87654321" [_A-Za-z0-9]{8,32}

# 返回值

参数列表 类型 描述 是否可空 默认值 示例 备注
_return Response 修改密码响应结果 * *

# 重置密码

# 方法

Response reset_password(String username, 
                   String password);

# 参数

参数列表 类型 描述 是否可空 默认值 示例 备注
username String 用户名 * "graph_owner" 不超过32个字符
password String 密码 * "12345678" 符合正则表达式规则 [_A-Za-z0-9]{8,32}

# 返回值

参数列表 类型 描述 是否可空 默认值 示例 备注
_return Response 重置密码响应结果 * *

# 赋予权限

# 方法

Response grant_roles(String username, 
                String graph, 
                List<String> roles);

# 参数

参数列表 类型 描述 是否可空 默认值 示例 备注
username String 用户名 * "graph_owner" 不超过32个字符
graph String 数据库名称 * "ezoo" 不超过32个字符
roles List 角色列表 * ["graph_owner"] 角色列表必须是内建角色名(小写字母)可参考角色与权限说明

# 返回值

参数列表 类型 描述 是否可空 默认值 示例 备注
_return Response 赋予权限响应结果 * *

# 取消权限

# 方法

Response cancel_grant_roles(String username, 
                       String graph);

# 参数

参数列表 类型 描述 是否可空 默认值 示例 备注
username String 用户名 * "graph_owner" 不超过32个字符
graph String 数据库名称 * "ezoo" 不超过32个字符

# 返回值

参数列表 类型 描述 是否可空 默认值 示例 备注
_return Response 取消权限响应结果 * *

# 查询用户角色

# 方法

user_roles view_roles(String username);

# 参数

参数列表 类型 描述 是否可空 默认值 示例 备注
username String 用户名 * "graph_owner" 不超过32个字符

# 返回值

参数列表 类型 描述 是否可空 默认值 示例 备注
_return user_roles 查询用户角色响应结果 * *

# 查询图所属用户

# 方法

user_roles view_users(String graph);

# 参数

参数列表 类型 描述 是否可空 默认值 示例 备注
graph String 数据库名称 * "ezoo" 不超过32个字符

# 返回值

参数列表 类型 描述 是否可空 默认值 示例 备注
_return user_roles 查询图所属用户响应结果 * *

# 查询所有用户角色

当且仅当拥有admin或者root角色的用户能调用该接口。

# 方法

user_graph_roles view_all_users();

# 参数

参数列表 类型 描述 是否可空 默认值 示例 备注

# 返回值

参数列表 类型 描述 是否可空 默认值 示例 备注
_return user_graph_roles 查询所有用户角色图响应结果 * *

最近一次更新时间: 5/26/2022, 9:59:19 AM